GraphQL API reference UI usage
The Developer Portal includes a GraphQL editor for writing, testing, and viewing GraphQL APIs. It automatically fetches a GraphQL API's schema using introspection and shows the available data fields, queries, and mutations for the endpoint.
If your schema requires authentication, provide the authentication header to execute the query.
You can also perform various other operations in the GraphQL editor, such as viewing documentation in Document Explorer or History. You can also use Explorer schema to add a data field to the query operation, re-fetch the schema, open shortcut keys, and manage settings.
If an API is under any authentication, the introspection queries will fail to display any information in the Document Explorer.
About GraphQL query, headers, request, and response
The following is an example of testing the GraphQL query on the Developer Portal.
Adding query and headers
To test your GraphQL query, first add the query in the request section. On the left-hand side, you can use the Show GraphQL Explorer to add fields to the query operation. Select the fields to mark them selected to insert them into the query operation.
If your schema needs authentication, provide the authentication header in the Headers section. Then, run the query by clicking Execute query button.
The query returns results as a JSON object on the right side of the editor.
